Voucher entities
| Name | Type | Is Mandatory |
|---|---|---|
| VoucherId | Int32 | |
| VoucherIdentifier | String | |
| ContactId | Int32 | |
| LoyaltyCardId | Int32 | |
| SourceId | Int16 | |
| VoucherCode | String | |
| VoucherTypeId | Int16 | |
| VoucherStateId | Int16 | |
| Amount | Decimal | |
| CurrencyId | String | |
| ValidityStartDate | DateTime | |
| ValidityEndDate | DateTime | |
| DeletionFlag | Boolean | |
| VoucherCategoryId | Int16 | |
| UseDate | DateTime | |
| VoucherState | VoucherState | |
| VoucherType | VoucherType | |
| Contact | Contact | |
| LoyaltyCard | LoyaltyCard | |
| Currency | Currency | |
| Source | Source | |
| LoyaltyPoints | Collection of LoyaltyPoint | |
| PurchaseHeaders | Collection of PurchaseHeader | |
| VoucherCategory | VoucherCategory |
Select all Vouchers
https://customerapi.fts-crm360.com/data/Vouchers()
HttpMethod : GET
Json Result :
[
{
"VoucherId" : "31",
"VoucherIdentifier" : "nYos3M",
"ContactId" : "3",
"LoyaltyCardId" : "26",
"SourceId" : "7",
"VoucherCode" : "2nW6az2",
"VoucherTypeId" : "1",
"VoucherStateId" : "3",
"Amount" : "7987214.298",
"CurrencyId" : "twE WuNr q1",
"ValidityStartDate" : "2010-02-12T00:00:00",
"ValidityEndDate" : "2003-05-12T00:00:00",
"DeletionFlag" : "True",
"VoucherCategoryId" : "9",
"UseDate" : "2012-06-28T00:00:00"
},
{
"VoucherId" : "63",
"VoucherIdentifier" : "BVS2S",
"ContactId" : "54",
"LoyaltyCardId" : "18",
"SourceId" : "7",
"VoucherCode" : "gofDHYTbFhgjskL",
"VoucherTypeId" : "1",
"VoucherStateId" : "6",
"Amount" : "9466257.285",
"CurrencyId" : "0diolCr",
"ValidityStartDate" : "1996-06-15T00:00:00",
"ValidityEndDate" : "2010-08-02T00:00:00",
"DeletionFlag" : "False",
"VoucherCategoryId" : "7",
"UseDate" : "1998-02-22T00:00:00"
},
...
]
Select Voucher by Id
https://customerapi.fts-crm360.com/data/Vouchers(31)
HttpMethod : GET
Json Result :
{
"VoucherId" : "97",
"VoucherIdentifier" : "yBFbVwGxonwLGTI",
"ContactId" : "74",
"LoyaltyCardId" : "95",
"SourceId" : "3",
"VoucherCode" : "Imm939p3IjBKTm4 cp",
"VoucherTypeId" : "6",
"VoucherStateId" : "5",
"Amount" : "7118984.949",
"CurrencyId" : "ocO DLCNdr29Mlbc",
"ValidityStartDate" : "2012-06-11T00:00:00",
"ValidityEndDate" : "2001-06-06T00:00:00",
"DeletionFlag" : "False",
"VoucherCategoryId" : "7",
"UseDate" : "1997-07-08T00:00:00"
}
Create a Voucher
https://customerapi.fts-crm360.com/data/Vouchers()
HttpMethod : POST
Json Post :
{
"VoucherIdentifier" : "vGEixD jt",
"ContactId" : "51",
"LoyaltyCardId" : "23",
"SourceId" : "8",
"VoucherCode" : "tEx0OZbL04",
"VoucherTypeId" : "1",
"VoucherStateId" : "8",
"Amount" : "3548753.747",
"CurrencyId" : "ufZ M4",
"ValidityStartDate" : "2024-06-17T00:00:00",
"ValidityEndDate" : "2006-01-14T00:00:00",
"DeletionFlag" : "True",
"VoucherCategoryId" : "4",
"UseDate" : "2001-02-15T00:00:00"
}
Informations :
- Non mandatory fields are optional for Json Post
Update a Voucher
https://customerapi.fts-crm360.com/data/Vouchers(31)
HttpMethod : PUT
Json Post :
{
"VoucherId" : "73",
"VoucherIdentifier" : "xXoRnF4N s",
"ContactId" : "53",
"LoyaltyCardId" : "60",
"SourceId" : "6",
"VoucherCode" : "HB 7CU PS2hV",
"VoucherTypeId" : "5",
"VoucherStateId" : "1",
"Amount" : "7114891.389",
"CurrencyId" : "z2YlJ9WuRJvauBz",
"ValidityStartDate" : "2021-08-08T00:00:00",
"ValidityEndDate" : "2006-11-08T00:00:00",
"DeletionFlag" : "True",
"VoucherCategoryId" : "1",
"UseDate" : "2015-09-20T00:00:00"
}
Informations :
- Non mandatory fields are optional for Json Post
Patch a Voucher
https://customerapi.fts-crm360.com/data/Vouchers(31)
HttpMethod : PATCH
Json Post :
{
"ContactId" : "67",
"ValidityStartDate" : "2002-09-01T00:00:00",
"VoucherTypeId" : "5"
}
Informations :
- Non mandatory fields are optional for Json Post
Delete a Voucher
https://customerapi.fts-crm360.com/data/Vouchers(31)
HttpMethod : DELETE